<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.commons.net.tftp;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.net.DatagramPacket;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.net.InetAddress;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/***<a name="line.23"></a>
<span class="sourceLineNo">024</span> * TFTPPacket is an abstract class encapsulating the functionality common<a name="line.24"></a>
<span class="sourceLineNo">025</span> * to the 5 types of TFTP packets.  It also provides a static factory<a name="line.25"></a>
<span class="sourceLineNo">026</span> * method that will create the correct TFTP packet instance from a<a name="line.26"></a>
<span class="sourceLineNo">027</span> * datagram.  This relieves the programmer from having to figure out what<a name="line.27"></a>
<span class="sourceLineNo">028</span> * kind of TFTP packet is contained in a datagram and create it himself.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Details regarding the TFTP protocol and the format of TFTP packets can<a name="line.30"></a>
<span class="sourceLineNo">031</span> * be found in RFC 783.  But the point of these classes is to keep you<a name="line.31"></a>
<span class="sourceLineNo">032</span> * from having to worry about the internals.  Additionally, only very<a name="line.32"></a>
<span class="sourceLineNo">033</span> * few people should have to care about any of the TFTPPacket classes<a name="line.33"></a>
<span class="sourceLineNo">034</span> * or derived classes.  Almost all users should only be concerned with the<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@link org.apache.commons.net.tftp.TFTPClient} class<a name="line.35"></a>
<span class="sourceLineNo">036</span> * {@link org.apache.commons.net.tftp.TFTPClient#receiveFile receiveFile()}<a name="line.36"></a>
<span class="sourceLineNo">037</span> * and<a name="line.37"></a>
<span class="sourceLineNo">038</span> * {@link org.apache.commons.net.tftp.TFTPClient#sendFile sendFile()}<a name="line.38"></a>
<span class="sourceLineNo">039</span> * methods.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;p&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @see TFTPPacketException<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @see TFTP<a name="line.43"></a>
<span class="sourceLineNo">044</span> ***/<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>public abstract class TFTPPacket<a name="line.46"></a>
<span class="sourceLineNo">047</span>{<a name="line.47"></a>
<span class="sourceLineNo">048</span>    /***<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * The minimum size of a packet.  This is 4 bytes.  It is enough<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * to store the opcode and blocknumber or other required data<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * depending on the packet type.<a name="line.51"></a>
<span class="sourceLineNo">052</span>     ***/<a name="line.52"></a>
<span class="sourceLineNo">053</span>    static final int MIN_PACKET_SIZE = 4;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>    /***<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * This is the actual TFTP spec<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * identifier and is equal to 1.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * Identifier returned by {@link #getType getType()}<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * indicating a read request packet.<a name="line.59"></a>
<span class="sourceLineNo">060</span>     ***/<a name="line.60"></a>
<span class="sourceLineNo">061</span>    public static final int READ_REQUEST = 1;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span>    /***<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * This is the actual TFTP spec<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * identifier and is equal to 2.<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * Identifier returned by {@link #getType getType()}<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * indicating a write request packet.<a name="line.67"></a>
<span class="sourceLineNo">068</span>     ***/<a name="line.68"></a>
<span class="sourceLineNo">069</span>    public static final int WRITE_REQUEST = 2;<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>    /***<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * This is the actual TFTP spec<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * identifier and is equal to 3.<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * Identifier returned by {@link #getType getType()}<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * indicating a data packet.<a name="line.75"></a>
<span class="sourceLineNo">076</span>     ***/<a name="line.76"></a>
<span class="sourceLineNo">077</span>    public static final int DATA = 3;<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>    /***<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * This is the actual TFTP spec<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * identifier and is equal to 4.<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * Identifier returned by {@link #getType getType()}<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * indicating an acknowledgement packet.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     ***/<a name="line.84"></a>
<span class="sourceLineNo">085</span>    public static final int ACKNOWLEDGEMENT = 4;<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    /***<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * This is the actual TFTP spec<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * identifier and is equal to 5.<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Identifier returned by {@link #getType getType()}<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * indicating an error packet.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     ***/<a name="line.92"></a>
<span class="sourceLineNo">093</span>    public static final int ERROR = 5;<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span>    /***<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * The TFTP data packet maximum segment size in bytes.  This is 512<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * and is useful for those familiar with the TFTP protocol who want<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * to use the {@link org.apache.commons.net.tftp.TFTP}<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * class methods to implement their own TFTP servers or clients.<a name="line.99"></a>
<span class="sourceLineNo">100</span>     ***/<a name="line.100"></a>
<span class="sourceLineNo">101</span>    public static final int SEGMENT_SIZE = 512;<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>    /*** The type of packet. ***/<a name="line.103"></a>
<span class="sourceLineNo">104</span>    int _type;<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    /*** The port the packet came from or is going to. ***/<a name="line.106"></a>
<span class="sourceLineNo">107</span>    int _port;<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span>    /*** The host the packet is going to be sent or where it came from. ***/<a name="line.109"></a>
<span class="sourceLineNo">110</span>    InetAddress _address;<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>    /***<a name="line.112"></a>
<span class="sourceLineNo">113</span>     * When you receive a datagram that you expect to be a TFTP packet, you use<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * this factory method to create the proper TFTPPacket object<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * encapsulating the data contained in that datagram.  This method is the<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * only way you can instantiate a TFTPPacket derived class from a<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * datagram.<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * &lt;p&gt;<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * @param datagram  The datagram containing a TFTP packet.<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * @return The TFTPPacket object corresponding to the datagram.<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * @exception TFTPPacketException  If the datagram does not contain a valid<a name="line.121"></a>
<span class="sourceLineNo">122</span>     *             TFTP packet.<a name="line.122"></a>
<span class="sourceLineNo">123</span>     ***/<a name="line.123"></a>
<span class="sourceLineNo">124</span>    public final static TFTPPacket newTFTPPacket(DatagramPacket datagram)<a name="line.124"></a>
<span class="sourceLineNo">125</span>    throws TFTPPacketException<a name="line.125"></a>
<span class="sourceLineNo">126</span>    {<a name="line.126"></a>
<span class="sourceLineNo">127</span>        byte[] data;<a name="line.127"></a>
<span class="sourceLineNo">128</span>        TFTPPacket packet = null;<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span>        if (datagram.getLength() &lt; MIN_PACKET_SIZE) {<a name="line.130"></a>
<span class="sourceLineNo">131</span>            throw new TFTPPacketException(<a name="line.131"></a>
<span class="sourceLineNo">132</span>                "Bad packet. Datagram data length is too short.");<a name="line.132"></a>
<span class="sourceLineNo">133</span>        }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>        data = datagram.getData();<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>        switch (data[1])<a name="line.137"></a>
<span class="sourceLineNo">138</span>        {<a name="line.138"></a>
<span class="sourceLineNo">139</span>        case READ_REQUEST:<a name="line.139"></a>
<span class="sourceLineNo">140</span>            packet = new TFTPReadRequestPacket(datagram);<a name="line.140"></a>
<span class="sourceLineNo">141</span>            break;<a name="line.141"></a>
<span class="sourceLineNo">142</span>        case WRITE_REQUEST:<a name="line.142"></a>
<span class="sourceLineNo">143</span>            packet = new TFTPWriteRequestPacket(datagram);<a name="line.143"></a>
<span class="sourceLineNo">144</span>            break;<a name="line.144"></a>
<span class="sourceLineNo">145</span>        case DATA:<a name="line.145"></a>
<span class="sourceLineNo">146</span>            packet = new TFTPDataPacket(datagram);<a name="line.146"></a>
<span class="sourceLineNo">147</span>            break;<a name="line.147"></a>
<span class="sourceLineNo">148</span>        case ACKNOWLEDGEMENT:<a name="line.148"></a>
<span class="sourceLineNo">149</span>            packet = new TFTPAckPacket(datagram);<a name="line.149"></a>
<span class="sourceLineNo">150</span>            break;<a name="line.150"></a>
<span class="sourceLineNo">151</span>        case ERROR:<a name="line.151"></a>
<span class="sourceLineNo">152</span>            packet = new TFTPErrorPacket(datagram);<a name="line.152"></a>
<span class="sourceLineNo">153</span>            break;<a name="line.153"></a>
<span class="sourceLineNo">154</span>        default:<a name="line.154"></a>
<span class="sourceLineNo">155</span>            throw new TFTPPacketException(<a name="line.155"></a>
<span class="sourceLineNo">156</span>                "Bad packet.  Invalid TFTP operator code.");<a name="line.156"></a>
<span class="sourceLineNo">157</span>        }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span>        return packet;<a name="line.159"></a>
<span class="sourceLineNo">160</span>    }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span>    /***<a name="line.162"></a>
<span class="sourceLineNo">163</span>     * This constructor is not visible outside of the package.  It is used<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * by subclasses within the package to initialize base data.<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * &lt;p&gt;<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * @param type The type of the packet.<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * @param address The host the packet came from or is going to be sent.<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * @param port The port the packet came from or is going to be sent.<a name="line.168"></a>
<span class="sourceLineNo">169</span>     **/<a name="line.169"></a>
<span class="sourceLineNo">170</span>    TFTPPacket(int type, InetAddress address, int port)<a name="line.170"></a>
<span class="sourceLineNo">171</span>    {<a name="line.171"></a>
<span class="sourceLineNo">172</span>        _type = type;<a name="line.172"></a>
<span class="sourceLineNo">173</span>        _address = address;<a name="line.173"></a>
<span class="sourceLineNo">174</span>        _port = port;<a name="line.174"></a>
<span class="sourceLineNo">175</span>    }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span>    /***<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * This is an abstract method only available within the package for<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * implementing efficient datagram transport by elminating buffering.<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * It takes a datagram as an argument, and a byte buffer in which<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * to store the raw datagram data.  Inside the method, the data<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * should be set as the datagram's data and the datagram returned.<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * &lt;p&gt;<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * @param datagram  The datagram to create.<a name="line.184"></a>
<span class="sourceLineNo">185</span>     * @param data The buffer to store the packet and to use in the datagram.<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * @return The datagram argument.<a name="line.186"></a>
<span class="sourceLineNo">187</span>     ***/<a name="line.187"></a>
<span class="sourceLineNo">188</span>    abstract DatagramPacket _newDatagram(DatagramPacket datagram, byte[] data);<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span>    /***<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * Creates a UDP datagram containing all the TFTP packet<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * data in the proper format.<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * This is an abstract method, exposed to the programmer in case he<a name="line.193"></a>
<span class="sourceLineNo">194</span>     * wants to implement his own TFTP client instead of using<a name="line.194"></a>
<span class="sourceLineNo">195</span>     * the {@link org.apache.commons.net.tftp.TFTPClient}<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * class.<a name="line.196"></a>
<span class="sourceLineNo">197</span>     * Under normal circumstances, you should not have a need to call this<a name="line.197"></a>
<span class="sourceLineNo">198</span>     * method.<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * &lt;p&gt;<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * @return A UDP datagram containing the TFTP packet.<a name="line.200"></a>
<span class="sourceLineNo">201</span>     ***/<a name="line.201"></a>
<span class="sourceLineNo">202</span>    public abstract DatagramPacket newDatagram();<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span>    /***<a name="line.204"></a>
<span class="sourceLineNo">205</span>     * Returns the type of the packet.<a name="line.205"></a>
<span class="sourceLineNo">206</span>     * &lt;p&gt;<a name="line.206"></a>
<span class="sourceLineNo">207</span>     * @return The type of the packet.<a name="line.207"></a>
<span class="sourceLineNo">208</span>     ***/<a name="line.208"></a>
<span class="sourceLineNo">209</span>    public final int getType()<a name="line.209"></a>
<span class="sourceLineNo">210</span>    {<a name="line.210"></a>
<span class="sourceLineNo">211</span>        return _type;<a name="line.211"></a>
<span class="sourceLineNo">212</span>    }<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span>    /***<a name="line.214"></a>
<span class="sourceLineNo">215</span>     * Returns the address of the host where the packet is going to be sent<a name="line.215"></a>
<span class="sourceLineNo">216</span>     * or where it came from.<a name="line.216"></a>
<span class="sourceLineNo">217</span>     * &lt;p&gt;<a name="line.217"></a>
<span class="sourceLineNo">218</span>     * @return The type of the packet.<a name="line.218"></a>
<span class="sourceLineNo">219</span>     ***/<a name="line.219"></a>
<span class="sourceLineNo">220</span>    public final InetAddress getAddress()<a name="line.220"></a>
<span class="sourceLineNo">221</span>    {<a name="line.221"></a>
<span class="sourceLineNo">222</span>        return _address;<a name="line.222"></a>
<span class="sourceLineNo">223</span>    }<a name="line.223"></a>
<span class="sourceLineNo">224</span><a name="line.224"></a>
<span class="sourceLineNo">225</span>    /***<a name="line.225"></a>
<span class="sourceLineNo">226</span>     * Returns the port where the packet is going to be sent<a name="line.226"></a>
<span class="sourceLineNo">227</span>     * or where it came from.<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * &lt;p&gt;<a name="line.228"></a>
<span class="sourceLineNo">229</span>     * @return The port where the packet came from or where it is going.<a name="line.229"></a>
<span class="sourceLineNo">230</span>     ***/<a name="line.230"></a>
<span class="sourceLineNo">231</span>    public final int getPort()<a name="line.231"></a>
<span class="sourceLineNo">232</span>    {<a name="line.232"></a>
<span class="sourceLineNo">233</span>        return _port;<a name="line.233"></a>
<span class="sourceLineNo">234</span>    }<a name="line.234"></a>
<span class="sourceLineNo">235</span><a name="line.235"></a>
<span class="sourceLineNo">236</span>    /*** Sets the port where the packet is going to be sent. ***/<a name="line.236"></a>
<span class="sourceLineNo">237</span>    public final void setPort(int port)<a name="line.237"></a>
<span class="sourceLineNo">238</span>    {<a name="line.238"></a>
<span class="sourceLineNo">239</span>        _port = port;<a name="line.239"></a>
<span class="sourceLineNo">240</span>    }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span>    /*** Sets the host address where the packet is going to be sent. ***/<a name="line.242"></a>
<span class="sourceLineNo">243</span>    public final void setAddress(InetAddress address)<a name="line.243"></a>
<span class="sourceLineNo">244</span>    {<a name="line.244"></a>
<span class="sourceLineNo">245</span>        _address = address;<a name="line.245"></a>
<span class="sourceLineNo">246</span>    }<a name="line.246"></a>
<span class="sourceLineNo">247</span>}<a name="line.247"></a>




























































</pre>
</div>
</body>
</html>
